Add test instructions to test/README #54
Conversation
|
The way to run the tests in RDoc are the same as for any Hoe project. The first time: Every subsequent time: While I'm not completely sure that RDoc needs such instructions, they shouldn't go in test/README, but in the regular README. |
|
Sounds reasonable to me - I added to the test/README because I rarely see a second README and I thought you were making a distinction. I think some kind of instructions would be very helpful. Here's what happens when you don't know how to use Hoe (I don't) and you start from nothing: $ rvm use 1.8.7@rdoc
Using /Users/chiangs/.rvm/gems/ruby-1.8.7-p302 with gemset rdoc
$ gem install rake
Fetching: rake-0.9.2.gem (100%)
Successfully installed rake-0.9.2
1 gem installed
$ rake newb
rake aborted!
no such file to load -- hoe
(See full trace by running task with --trace)
$ gem install hoe
Fetching: hoe-2.10.0.gem (100%)
Successfully installed hoe-2.10.0
1 gem installed
$ rake newb
rake aborted!
undefined method `isolate_dir=' for #<Hoe:0x10166fda8>
(See full trace by running task with --trace)At this point I'm stuck. In fact I went through something similar to arrive at this pull request -- after messing with the Rakefile a bit and getting nowhere I eventually guessed you ran the tests manually and installed gems as needed to get everything to go. |
|
I fixed the isolate_dir= problem so now just |
3 participants
The previous content was funny but it was a little work figuring out how to get the tests to run. Something like this would be a great help to newbies like me.
Incidentally something similar might be helpful for the Rakefile -- when I run rake I run into the hoe dependency, the version of which is not clearly indicated but I figured out is probably ~> 2.9. After installing I get errors because the plugins aren't set up and I stopped pursing it. But that's a separate issue.